<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>PintarOS: File System</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">PintarOS
   </div>
   <div id="projectbrief">Operating System for Smart Card</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Groups</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">File System</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__fs__structure"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs__structure.html">File System Structure</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structEF__st.html">EF_st</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure of EF file header  <a href="structEF__st.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDF__st.html">DF_st</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">structure of DF file descriptor  <a href="structDF__st.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga3167e1c51bc79684fdfb78c181075d11"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga3167e1c51bc79684fdfb78c181075d11">FS_SIZE</a>&#160;&#160;&#160;CONFIG_FS_SIZE</td></tr>
<tr class="separator:ga3167e1c51bc79684fdfb78c181075d11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga484d3b027c362670c91431b360d8e41a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga484d3b027c362670c91431b360d8e41a">FS_START</a>&#160;&#160;&#160;CONFIG_FS_START</td></tr>
<tr class="separator:ga484d3b027c362670c91431b360d8e41a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad6b56bdbbe5838a6260ddc0926fa1891"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#gad6b56bdbbe5838a6260ddc0926fa1891">FS_BLOCK_SIZE</a>&#160;&#160;&#160;CONFIG_FS_BLOCK_SIZE</td></tr>
<tr class="separator:gad6b56bdbbe5838a6260ddc0926fa1891"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5534402cd21abf73c1851e468ca502c4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga5534402cd21abf73c1851e468ca502c4">FS_BLOCKS</a>&#160;&#160;&#160;<a class="el" href="group__fs.html#ga3167e1c51bc79684fdfb78c181075d11">FS_SIZE</a>/<a class="el" href="group__fs.html#gad6b56bdbbe5838a6260ddc0926fa1891">FS_BLOCK_SIZE</a></td></tr>
<tr class="separator:ga5534402cd21abf73c1851e468ca502c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gae0b7a8fdbb83d5bdeaf6ee5bab8054fe"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#gae0b7a8fdbb83d5bdeaf6ee5bab8054fe">ef_struct</a> { <a class="el" href="group__fs.html#ggae0b7a8fdbb83d5bdeaf6ee5bab8054feac719d3f34968bcf992d4c0c48841cf63">Transparent</a>, 
<a class="el" href="group__fs.html#ggae0b7a8fdbb83d5bdeaf6ee5bab8054feae0da40ac190d835380202f40a9fc76eb">Record</a>, 
<a class="el" href="group__fs.html#ggae0b7a8fdbb83d5bdeaf6ee5bab8054fea5aa1e27646a18fb490c0ff4a9b7b2f6e">Cyclic</a>
 }</td></tr>
<tr class="memdesc:gae0b7a8fdbb83d5bdeaf6ee5bab8054fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">EF File Structure enumeration.  <a href="group__fs.html#gae0b7a8fdbb83d5bdeaf6ee5bab8054fe">More...</a><br/></td></tr>
<tr class="separator:gae0b7a8fdbb83d5bdeaf6ee5bab8054fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f46d6e4f39750fecff1240810793832"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga6f46d6e4f39750fecff1240810793832">ef_type</a> { <a class="el" href="group__fs.html#gga6f46d6e4f39750fecff1240810793832a7352fd1878874b86d44e973e7b7c046e">Working</a>, 
<a class="el" href="group__fs.html#gga6f46d6e4f39750fecff1240810793832aa992d66faf4c155dfd78ec168fc25f8a">Internal</a>
 }</td></tr>
<tr class="memdesc:ga6f46d6e4f39750fecff1240810793832"><td class="mdescLeft">&#160;</td><td class="mdescRight">EF File Type enumeration.  <a href="group__fs.html#ga6f46d6e4f39750fecff1240810793832">More...</a><br/></td></tr>
<tr class="separator:ga6f46d6e4f39750fecff1240810793832"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5f5f0f157759a32e861b2d8177911353"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga5f5f0f157759a32e861b2d8177911353">FSInitialize</a> ()</td></tr>
<tr class="memdesc:ga5f5f0f157759a32e861b2d8177911353"><td class="mdescLeft">&#160;</td><td class="mdescRight">InitializerInitialize file system.  <a href="#ga5f5f0f157759a32e861b2d8177911353">More...</a><br/></td></tr>
<tr class="separator:ga5f5f0f157759a32e861b2d8177911353"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafed36802a2254132739776c576c0e53e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#gafed36802a2254132739776c576c0e53e">FSGetHeader</a> (uint16_t block_addr, uint8_t offset, uint8_t *dest)</td></tr>
<tr class="memdesc:gafed36802a2254132739776c576c0e53e"><td class="mdescLeft">&#160;</td><td class="mdescRight">FSGetHeaderFile system function to retrieve header information of a file.  <a href="#gafed36802a2254132739776c576c0e53e">More...</a><br/></td></tr>
<tr class="separator:gafed36802a2254132739776c576c0e53e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab1bf818b552bb3c24080e3249112e026"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#gab1bf818b552bb3c24080e3249112e026">FSSelectMF</a> ()</td></tr>
<tr class="memdesc:gab1bf818b552bb3c24080e3249112e026"><td class="mdescLeft">&#160;</td><td class="mdescRight">select MFFile system function to select MF  <a href="#gab1bf818b552bb3c24080e3249112e026">More...</a><br/></td></tr>
<tr class="separator:gab1bf818b552bb3c24080e3249112e026"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6df8bb917f2541f08f75796623a956a4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga6df8bb917f2541f08f75796623a956a4">FSSelectFID</a> (uint16_t fid)</td></tr>
<tr class="memdesc:ga6df8bb917f2541f08f75796623a956a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">select with full FIDFile system function to select a file with full FID  <a href="#ga6df8bb917f2541f08f75796623a956a4">More...</a><br/></td></tr>
<tr class="separator:ga6df8bb917f2541f08f75796623a956a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11624170ed19096e661a18cf31ae0cfb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga11624170ed19096e661a18cf31ae0cfb">FSSelectPath</a> (uint16_t *path, int length)</td></tr>
<tr class="memdesc:ga11624170ed19096e661a18cf31ae0cfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">select with pathFile system function to select a file with path  <a href="#ga11624170ed19096e661a18cf31ae0cfb">More...</a><br/></td></tr>
<tr class="separator:ga11624170ed19096e661a18cf31ae0cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e04aaa657e9c4bcca8323c8779fc687"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga9e04aaa657e9c4bcca8323c8779fc687">FSSelectSFID</a> (uint8_t sfid)</td></tr>
<tr class="memdesc:ga9e04aaa657e9c4bcca8323c8779fc687"><td class="mdescLeft">&#160;</td><td class="mdescRight">select with short FIDFile system function to select a file with short FID  <a href="#ga9e04aaa657e9c4bcca8323c8779fc687">More...</a><br/></td></tr>
<tr class="separator:ga9e04aaa657e9c4bcca8323c8779fc687"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga697390f044810e38c9308d12109487a9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga697390f044810e38c9308d12109487a9">FSSelectName</a> (char *DFname, uint8_t length)</td></tr>
<tr class="memdesc:ga697390f044810e38c9308d12109487a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">select with nameFile system function to select a DF file with name  <a href="#ga697390f044810e38c9308d12109487a9">More...</a><br/></td></tr>
<tr class="separator:ga697390f044810e38c9308d12109487a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f8915bf60a20928be8f7ab9a5750309"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga9f8915bf60a20928be8f7ab9a5750309">FSAccessBinary</a> (int op, int offset, int length, uint8_t *databyte)</td></tr>
<tr class="memdesc:ga9f8915bf60a20928be8f7ab9a5750309"><td class="mdescLeft">&#160;</td><td class="mdescRight">access a transparent fileFile system function to access (read &amp; update) a transparent file  <a href="#ga9f8915bf60a20928be8f7ab9a5750309">More...</a><br/></td></tr>
<tr class="separator:ga9f8915bf60a20928be8f7ab9a5750309"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadee7ce5359cf03ffb89420e4012ca8b9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#gadee7ce5359cf03ffb89420e4012ca8b9">FSAccessRecord</a> (int op, int recordNum, int length, uint8_t *databyte)</td></tr>
<tr class="memdesc:gadee7ce5359cf03ffb89420e4012ca8b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">access a record fileFile system function to access a record file  <a href="#gadee7ce5359cf03ffb89420e4012ca8b9">More...</a><br/></td></tr>
<tr class="separator:gadee7ce5359cf03ffb89420e4012ca8b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga57bbc0e2b610758d6710826166345004"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#ga57bbc0e2b610758d6710826166345004">FSCreateFile</a> (int tag, void *desc)</td></tr>
<tr class="memdesc:ga57bbc0e2b610758d6710826166345004"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a new fileFile system function to create a file  <a href="#ga57bbc0e2b610758d6710826166345004">More...</a><br/></td></tr>
<tr class="separator:ga57bbc0e2b610758d6710826166345004"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab24d6b7331b45fa5ad94f87244f4ce29"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__fs.html#gab24d6b7331b45fa5ad94f87244f4ce29">FSDeleteFile</a> (uint16_t fid)</td></tr>
<tr class="memdesc:gab24d6b7331b45fa5ad94f87244f4ce29"><td class="mdescLeft">&#160;</td><td class="mdescRight">delete a fileFile system function to delete a file  <a href="#gab24d6b7331b45fa5ad94f87244f4ce29">More...</a><br/></td></tr>
<tr class="separator:gab24d6b7331b45fa5ad94f87244f4ce29"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>File System Module </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gad6b56bdbbe5838a6260ddc0926fa1891"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FS_BLOCK_SIZE&#160;&#160;&#160;CONFIG_FS_BLOCK_SIZE</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Define the size of block to be used Get the value from CONFIG_FS_BLOCK_SIZE </p>

</div>
</div>
<a class="anchor" id="ga5534402cd21abf73c1851e468ca502c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FS_BLOCKS&#160;&#160;&#160;<a class="el" href="group__fs.html#ga3167e1c51bc79684fdfb78c181075d11">FS_SIZE</a>/<a class="el" href="group__fs.html#gad6b56bdbbe5838a6260ddc0926fa1891">FS_BLOCK_SIZE</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Define the number of blocks available Value obtained from FS_SIZE and FS_BLOCK_SIZE </p>

</div>
</div>
<a class="anchor" id="ga3167e1c51bc79684fdfb78c181075d11"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FS_SIZE&#160;&#160;&#160;CONFIG_FS_SIZE</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Define the file system size in bytes. Get the value from CONFIG_FS_SIZE </p>

</div>
</div>
<a class="anchor" id="ga484d3b027c362670c91431b360d8e41a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FS_START&#160;&#160;&#160;CONFIG_FS_START</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Define the start address given to file system Get the value from CONFIG_FS_START </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gae0b7a8fdbb83d5bdeaf6ee5bab8054fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__fs.html#gae0b7a8fdbb83d5bdeaf6ee5bab8054fe">ef_struct</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>EF File Structure enumeration. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggae0b7a8fdbb83d5bdeaf6ee5bab8054feac719d3f34968bcf992d4c0c48841cf63"></a>Transparent</em>&nbsp;</td><td class="fielddoc">
<p>File using transparent structure. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae0b7a8fdbb83d5bdeaf6ee5bab8054feae0da40ac190d835380202f40a9fc76eb"></a>Record</em>&nbsp;</td><td class="fielddoc">
<p>File using Record structure. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ggae0b7a8fdbb83d5bdeaf6ee5bab8054fea5aa1e27646a18fb490c0ff4a9b7b2f6e"></a>Cyclic</em>&nbsp;</td><td class="fielddoc">
<p>File using Cyclic Record Structure. </p>
</td></tr>
</table>

</div>
</div>
<a class="anchor" id="ga6f46d6e4f39750fecff1240810793832"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__fs.html#ga6f46d6e4f39750fecff1240810793832">ef_type</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>EF File Type enumeration. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga6f46d6e4f39750fecff1240810793832a7352fd1878874b86d44e973e7b7c046e"></a>Working</em>&nbsp;</td><td class="fielddoc">
<p>Working type file. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga6f46d6e4f39750fecff1240810793832aa992d66faf4c155dfd78ec168fc25f8a"></a>Internal</em>&nbsp;</td><td class="fielddoc">
<p>Internal type file. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga9f8915bf60a20928be8f7ab9a5750309"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSAccessBinary </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>op</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>databyte</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>access a transparent fileFile system function to access (read &amp; update) a transparent file </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">op</td><td>operation to perform </td></tr>
    <tr><td class="paramname">offset</td><td>offset of the data to read/update </td></tr>
    <tr><td class="paramname">length</td><td>length of the data to read/update </td></tr>
    <tr><td class="paramname">*data</td><td>pointer to data buffer </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="gadee7ce5359cf03ffb89420e4012ca8b9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSAccessRecord </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>op</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>recordNum</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>databyte</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>access a record fileFile system function to access a record file </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">op</td><td>operation to perform </td></tr>
    <tr><td class="paramname">recordNum</td><td>record Number </td></tr>
    <tr><td class="paramname">length</td><td>length of the data </td></tr>
    <tr><td class="paramname">*data</td><td>pointer to data buffer </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="ga57bbc0e2b610758d6710826166345004"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSCreateFile </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>tag</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>desc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>create a new fileFile system function to create a file </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">desc</td><td>Descriptor of the file </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="gab24d6b7331b45fa5ad94f87244f4ce29"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSDeleteFile </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>fid</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>delete a fileFile system function to delete a file </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">*fid</td><td>FID of the file to delete </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>File System Result enum </dd></dl>

</div>
</div>
<a class="anchor" id="gafed36802a2254132739776c576c0e53e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSGetHeader </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>block_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>dest</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>FSGetHeaderFile system function to retrieve header information of a file. </p>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="ga5f5f0f157759a32e861b2d8177911353"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSInitialize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>InitializerInitialize file system. </p>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="ga6df8bb917f2541f08f75796623a956a4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSSelectFID </td>
          <td>(</td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>fid</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>select with full FIDFile system function to select a file with full FID </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fid</td><td>FID of file to select </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="gab1bf818b552bb3c24080e3249112e026"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSSelectMF </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>select MFFile system function to select MF </p>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="ga697390f044810e38c9308d12109487a9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSSelectName </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>DFname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>select with nameFile system function to select a DF file with name </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DFname</td><td>pointer to DFname </td></tr>
    <tr><td class="paramname">length</td><td>length of DFname </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="ga11624170ed19096e661a18cf31ae0cfb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSSelectPath </td>
          <td>(</td>
          <td class="paramtype">uint16_t *&#160;</td>
          <td class="paramname"><em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>select with pathFile system function to select a file with path </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">path</td><td>pointer to path </td></tr>
    <tr><td class="paramname">length</td><td>length of the path </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
<a class="anchor" id="ga9e04aaa657e9c4bcca8323c8779fc687"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int FSSelectSFID </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>sfid</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>select with short FIDFile system function to select a file with short FID </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sfid</td><td>Short FID of file to select </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 4 2014 18:13:31 for PintarOS by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
